home *** CD-ROM | disk | FTP | other *** search
/ X User Tools / X User Tools (O'Reilly and Associates)(1994).ISO / sun4c / archive / xfsm.z / xfsm / man / catn / xfsm.n
Text File  |  1994-09-27  |  12KB  |  331 lines
  1.  
  2.  
  3.  
  4. XFSM(1)                  USER COMMANDS                        X11
  5.  
  6.  
  7.  
  8. NAME
  9.      xfsm - monitor your file systems' status
  10.  
  11. DESCRIPTION
  12.      xfsm stands for X File System Monitor and runs  under  MIT's
  13.      X11  window  system on several flavors of UNIX. It is a tool
  14.      designed to make monitoring your file systems'  status  easy
  15.      by  displaying  a  simple  bar  graph  for  each file system
  16.      greater than size 0. It updates the file systems' statistics
  17.      at regular, user definable intervals.
  18.  
  19. COMMAND LINE PARAMETERS
  20.      xfsm accepts the following command line options:
  21.  
  22.              +rv                     reverse video (use to override xrdb entry)
  23.              +synchronous            syncronous mode(use to override xrdb entry)
  24.              -?                      help
  25.              -a                      absolute display mode
  26.              -background <arg>       backgound color
  27.              -b                      black bars (disable gray fill)
  28.              -bg <arg>               same as -background
  29.              -bordercolor <arg>      border color
  30.              -borderwidth <arg>      border width
  31.              -detailgeometry <arg>   Geometry of detail window. Only X and Y are
  32.                                              honoured
  33.              -display                display
  34.              -e                      extend warning to ring bell when file
  35.                               system is above warning level
  36.           -f                      show free space rather than space used
  37.              -fg <arg>               same as -forground
  38.              -font <arg>             font
  39.              -foreground <arg>       forground color(also file system bar color)
  40.           -fsb                    draw file system bars without a border
  41.              -geometry <arg>         geometry (will override extreme window
  42.                               sizes to apply reasonable settings)
  43.              -help                   help
  44.              -i <arg>                interval at which stats are updated
  45.                                    (default=60s)
  46.              -iconic                 iconic
  47.              -m                      minimize window size
  48.              -mb                     draw menu borders
  49.              -mnl                    minimize window size so that the longest
  50.                               file system name fits
  51.              -name <arg>             run xfsm under this name
  52.              -p                      don't display percentages
  53.              -r                      display space with respect to root
  54.           -rs <arg>               specify the amount of space reserved for root
  55.                               default=10%
  56.              -rv                     reverse video
  57.              -synchronous            synchronous mode
  58.              -v                      verbose
  59.              -w <arg>                display warning when usage reaches <arg> %
  60.  
  61.  
  62.  
  63. ReadyPak                                                        1
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. XFSM(1)                  USER COMMANDS                        X11
  71.  
  72.  
  73.  
  74.              -wl1 <arg>              threshold for first warning level
  75.              -wl1c <arg>             color for first warning level
  76.              -wl2 <arg>              threshold for second warning level
  77.              -wl2c <arg>             color for second warning level
  78.              -wl3 <arg>              threshold for third warning level
  79.              -wl3c <arg>             color for third warning level
  80.              -xrm                    set an entry in the resource database for
  81.                                    this execution only
  82.              help                    help
  83.  
  84.  
  85. RESOURCES
  86.      xfsm can be controlled via the following resources:
  87.  
  88.              absolute                absolute display mode
  89.              background              universal backgound color
  90.              <filesystem>.background background color for a file system
  91.              bell                    extend warning to ring bell when any
  92.                                              file system is above warning level
  93.              borderColor             border color
  94.              borderWidth             border width
  95.              detailWin.geometry      Geometry of detail window. Only X and Y are
  96.                                              honored
  97.              detailWin.share         have detail window share file system color
  98.              display                 display
  99.              font                    font
  100.              foreground              universal foreground color
  101.              <filesystem>.foreground foreground color for a file system
  102.           fs_border      do we draw borders around file systems?
  103.              gray                    black bars
  104.              help                    show help
  105.              mainWin.geometry        main window geometry
  106.              iconic                  start program in iconic mode
  107.              minimize                minimize window size
  108.              menuborder              draw menu borders
  109.              name                    run xfsm under this name
  110.              percent                 don't display percentages
  111.              root                    display space with respect to root
  112.              reverseVideo            reverse video
  113.              synchronous             syncronous mode
  114.              updInterval             interval at which stats are updated
  115.              used                    show space free rather than space available
  116.              verbose                 verbose mode
  117.              warnval                 display warning pixmap when usage reaches
  118.                                    <arg>%
  119.              warn1val                threshold for first warning level
  120.              warn1col                color for first warning level
  121.              warn2val                threshold for second warning leve
  122.              warn2col                color for second warning level
  123.              warn3val                threshold for third warning level
  124.              warn3col                color for third warning level
  125.  
  126.  
  127.  
  128.  
  129. ReadyPak                                                        2
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. XFSM(1)                  USER COMMANDS                        X11
  137.  
  138.  
  139.  
  140. BRIEF USER'S GUIDE
  141.      The following abbreviations are used:
  142.  
  143.           LB      - left mouse button
  144.           MB      - middle mouse button
  145.           RB      - right mouse button
  146.  
  147.      Once you have started xfsm you will get a window  containing
  148.      at  least 1 bar graph (xfsm removes all file systems of size
  149.      0) and 2 menus. The Menus are:
  150.  
  151.           Update Now - updates all files systems' statistics now
  152.           Quit       - exits xfsm
  153.  
  154.      If you click on the graph of a file system (LB, MB) you  get
  155.      a  window  displaying  the  detailed statistics for the file
  156.      system.  Clicking on the  file  system  again  (LB,  MB)  or
  157.      clicking  in  the  detail window (LB, MB), closes the detail
  158.      window while clicking on another file system (LB, MB)  while
  159.      the  detail  window  is  open,  displays  this file system's
  160.      statistics in the detail window. (Check the 5th item in  the
  161.      Troubleshooting section in the documentation to see the lim-
  162.      itations of the default mode of xfsm with regard  to  calcu-
  163.      lating percentages.)
  164.  
  165.      The right mouse button is used to toggle the  display  mode.
  166.      The default startup mode graphs all file systems relative to
  167.      their size. By clicking with the right mouse button  in  any
  168.      of  the  windows,  the  graphs  are  drawn in absolute size.
  169.      Clicking (RB) again, reverts back to the original mode.
  170.  
  171.      If you have specified the -w flag with  a  valid  parameter,
  172.      xfsm  will  display  an  exclamation  mark  after  the  file
  173.      system's percent  display  when  the  file  system's  useage
  174.      exceeds  the  specified threshold. If you also specified the
  175.      -e option, xfsm will sound the bell when the above condition
  176.      is  true  for  at  least 1 file system when the file systems
  177.      statistics are updated. You can use the -wl1,  -wl1c,  -wl2,
  178.      -wl2c,  -wl3, -wl3c options to set additional warning levels
  179.      and associate them with colors. A word about colors: If  you
  180.      use  them  (ie. specify forground and background colors) you
  181.      probably want to use the -b flag to disable the  grey  fill.
  182.      If you don't do this, the color of the file system bars will
  183.      be filled using the gray tile, which IMHO looks rather  hor-
  184.      rible.
  185.  
  186.      Xfsm will recognize automount file systems. If file  systems
  187.      are  added  or removed after startup, they will be caught at
  188.      update time. Xfsm will then resize the main window to enable
  189.      it  properly  display  a status bar for each file system. If
  190.      you specify file systems to be ignored (via  the  -d  or  -D
  191.      option)  xfsm  will remember these file systems even if they
  192.  
  193.  
  194.  
  195. ReadyPak                                                        3
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202. XFSM(1)                  USER COMMANDS                        X11
  203.  
  204.  
  205.  
  206.      are not present at startup time. This enables  you  to  have
  207.      xfsm  ignore  file  systems which are not mounted at startup
  208.      time.
  209.  
  210.      The following keys can be used to control xfsm:
  211.  
  212.           q - quit xfsm
  213.           u - update now
  214.           t - toggle display mode
  215.           c - close the detail window
  216.  
  217.      The Detail Window  can  display  the  following  statistics.
  218.      Depending  on  the  system  you  are on, you may not get all
  219.      these statistics:
  220.  
  221.           Device Name             The actual device name
  222.           Total Size              The file system size in MB
  223.           Space Free              Free space in MB
  224.           Sapce Available         Space Available to non-root in MB
  225.           Mount Type          Type of Mount
  226.           Mount Option        Mount Options
  227.           Block Size              The size of a block in Bytes
  228.           Blocks                  The number of blocks
  229.           Blocks Free             The number of free blocks
  230.           Blocks Available        Blocks available to non-root
  231.           File Inodes             The number of Inodes
  232.           Free Inodes             The number of free Inodes
  233.           Inodes Availible        Inodes available to non-root user
  234.  
  235.      If a device name is too long to be dispayed  in  the  detail
  236.      window,  the  detail  window  will  resize to accomodate the
  237.      name. This resizing will take place every time a file system
  238.      name is too long to fit into the default width of the detail
  239.      window. You can resize the main window but xfsm will not let
  240.      you  make  the  main  window smaller beyond a certain point.
  241.      This is to ensure that the output remains neat and  legible.
  242.      When  the  main  window  is  not  wide enough to display the
  243.      entire name of a file system, the name will be truncated  so
  244.      that it does not overwrite the percentages.
  245.  
  246. AUTHOR
  247.      xfsm was written by Robert Gasch (rgasch@nl.oracle.com)  and
  248.      is copyright by the author.
  249.  
  250. CREDITS
  251.      The strstr() used for DYNIX ports  is  a  slightly  modified
  252.      version of the GNU source.
  253.  
  254.      Many thanks to the following people who  all  contributed  a
  255.      great deal to evolving xfsm to new levels of sophistication:
  256.  
  257.           Jim (etljmme@etlxd20.ericsson.se)
  258.  
  259.  
  260.  
  261. ReadyPak                                                        4
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268. XFSM(1)                  USER COMMANDS                        X11
  269.  
  270.  
  271.  
  272.           Joost (jhelberg@nl.oracle.com)
  273.           Malcolm (malcolmp@hydra.maths.unsw.edu.au)
  274.           Jose (josem@ender.tid.es)
  275.           R.K. (R.K.Lloyd@compsci.liverpool.ac.uk)
  276.  
  277.      Lastly, my apologies for not giving credit to all the people
  278.      who  helped  me out with this, offered their suggestions and
  279.      supplied platform exceptions for various UNIX falvors -  the
  280.      list would simple become too big.
  281.  
  282.  
  283.  
  284.  
  285.  
  286.  
  287.  
  288.  
  289.  
  290.  
  291.  
  292.  
  293.  
  294.  
  295.  
  296.  
  297.  
  298.  
  299.  
  300.  
  301.  
  302.  
  303.  
  304.  
  305.  
  306.  
  307.  
  308.  
  309.  
  310.  
  311.  
  312.  
  313.  
  314.  
  315.  
  316.  
  317.  
  318.  
  319.  
  320.  
  321.  
  322.  
  323.  
  324.  
  325.  
  326.  
  327. ReadyPak                                                        5
  328.  
  329.  
  330.  
  331.